##########################################################################
#
#  Copyright (c) 2015, Image Engine Design Inc. All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are
#  met:
#
#      * Redistributions of source code must retain the above
#        copyright notice, this list of conditions and the following
#        disclaimer.
#
#      * Redistributions in binary form must reproduce the above
#        copyright notice, this list of conditions and the following
#        disclaimer in the documentation and/or other materials provided with
#        the distribution.
#
#      * Neither the name of John Haddon nor the names of
#        any other contributors to this software may be used to endorse or
#        promote products derived from this software without specific prior
#        written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
#  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
#  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
#  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
#  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
##########################################################################

import IECore

import Gaffer
import GafferUI
import GafferUITest

class DocumentationTest( GafferUITest.TestCase ) :

	def testNodeDocumentation( self ) :

		self.maxDiff = None
		self.assertNodesAreDocumented( Gaffer )

	def testApplicationDocumentation( self ) :

		def walkParameters( parameter, undocumentedParameters, parameterName ) :

			if "." in parameterName and parameter.description == "" :
				undocumentedParameters.append( parameterName )

			if isinstance( parameter, IECore.CompoundParameter ) :
				for childParameterName, childParameter in parameter.items() :
					walkParameters( childParameter, undocumentedParameters, parameterName + "." + childParameterName )

		undocumentedApps = []
		undocumentedParameters = []

		appLoader = IECore.ClassLoader.defaultLoader( "GAFFER_APP_PATHS" )
		for appName in appLoader.classNames() :
			app = appLoader.load( appName )()

			if app.description == "" :
				undocumentedApps.append( appName )

			walkParameters( app.parameters(), undocumentedParameters, appName )

		self.assertEqual( undocumentedApps, [] )
		self.assertEqual( undocumentedParameters, [] )

	def testExamples( self ) :

		self.assertExampleFilesExist()
		self.assertExampleFilesDontReferenceUnstablePaths()

if __name__ == "__main__":
	unittest.main()
